home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_qt.idb / usr / freeware / catman / p_man / cat3 / qbitmap.Z / qbitmap
Encoding:
Text File  |  1998-10-28  |  11.6 KB  |  199 lines
  1.  
  2.  
  3.  
  4.      QQQQBBBBiiiittttmmmmaaaapppp((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))      QQQQBBBBiiiittttmmmmaaaapppp((((3333qqqqtttt))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.       QBitmap - Monochrome (1 bit depth) pixmaps
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.       #include <qbitmap.h>
  13.  
  14.       Inherits QPixmap.
  15.  
  16.     PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrrssss
  17.       QQQQBBBBiiiittttmmmmaaaapppp (((())))
  18.       QQQQBBBBiiiittttmmmmaaaapppp (((( iiiinnnntttt    _w,,,, iiiinnnntttt _h,,,, bbbboooooooollll _c_l_e_a_r
  19.       QQQQBBBBiiiittttmmmmaaaapppp (((( ccccoooonnnnsssstttt QQQQSSSSiiiizzzzeeee    &&&&,,,, bbbboooooooollll    _c_l_e_a_r ====    FFFFAAAALLLLSSSSEEEE ))))
  20.       QQQQBBBBiiiittttmmmmaaaapppp (((( iiiinnnntttt    _w,,,, iiiinnnntttt _h,,,, ccccoooonnnnsssstttt    uuuucccchhhhaaaarrrr ****    _b_i_t_s
  21.       QQQQBBBBiiiittttmmmmaaaapppp (((( ccccoooonnnnsssstttt QQQQSSSSiiiizzzzeeee    &&&&,,,, ccccoooonnnnsssstttt uuuucccchhhhaaaarrrr **** _b_i_t_s,,,, bbbboooooooollll
  22.           _i_s_X_b_i_t_m_a_p====FFFFAAAALLLLSSSSEEEE ))))
  23.       QQQQBBBBiiiittttmmmmaaaapppp (((( ccccoooonnnnsssstttt QQQQBBBBiiiittttmmmmaaaapppp &&&& ))))
  24.       QQQQBBBBiiiittttmmmmaaaapppp (((( ccccoooonnnnsssstttt cccchhhhaaaarrrr **** _f_i_l_e_N_a_m_e,,,, ccccoooonnnnsssstttt cccchhhhaaaarrrr ****    _f_o_r_m_a_t====0000 ))))
  25.       QQQQBBBBiiiittttmmmmaaaapppp&&&& ooooppppeeeerrrraaaattttoooorrrr==== (((( ccccoooonnnnsssstttt QQQQBBBBiiiittttmmmmaaaapppp &&&& ))))
  26.       QQQQBBBBiiiittttmmmmaaaapppp&&&& ooooppppeeeerrrraaaattttoooorrrr==== (((( ccccoooonnnnsssstttt QQQQPPPPiiiixxxxmmmmaaaapppp &&&& ))))
  27.       QQQQBBBBiiiittttmmmmaaaapppp&&&& ooooppppeeeerrrraaaattttoooorrrr==== (((( ccccoooonnnnsssstttt QQQQIIIImmmmaaaaggggeeee &&&& ))))
  28.       QQQQBBBBiiiittttmmmmaaaapppp xxxxFFFFoooorrrrmmmm    (((( ccccoooonnnnsssstttt    QQQQWWWWMMMMaaaattttrrrriiiixxxx &&&& )))) ccccoooonnnnsssstttt
  29.  
  30.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  31.       The QBitmap class provides monochrome    (1 bit depth) pixmaps.
  32.  
  33.       The QBitmap class is a monochrome off-screen paint device,
  34.       used mainly for creating custom mouse    cursors    or brushes.
  35.  
  36.       A QBitmap is a QPixmap with the depth    1. If a    pixmap with a
  37.       depth    greater    than 1 is assigned to a    bitmap,    the bitmap
  38.       will be automatically    dithered. A QBitmap is guaranteed to
  39.       always have the depth    1, unless it is    a null bitmap (has
  40.       depth    0).
  41.  
  42.       When drawing in a QBitmap (or    QPixmap    with depth 1), we
  43.       recommend using the global color0 and    color1 QColor objects.
  44.       Painting with    color0 sets the    bitmap bits to 0, and painting
  45.       with color1 sets the bits to 1. For a    bitmap,    0-bits
  46.       indicate background (or white) and 1-bits indicate
  47.       foreground (or black). Using the black and white QColor
  48.       objects make no sense, because the pixel value is not
  49.       necessarily 0    for black and 1    for white.
  50.  
  51.       Just like the    QPixmap    class, QBitmap is optimized by the use
  52.       of implicit sharing, so it is    very efficient to pass QBitmap
  53.       objects as arguments.
  54.  
  55.       See also: QPixmap, QPainter::drawPixmap(), bitBlt() and
  56.       Shared Classes
  57.  
  58.       Examples:  cursor/cursor.cpp
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                         (printed 9/22/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      QQQQBBBBiiiittttmmmmaaaapppp((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))      QQQQBBBBiiiittttmmmmaaaapppp((((3333qqqqtttt))))
  71.  
  72.  
  73.  
  74.      MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDOOOOCCCCUUUUMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  75.      QQQQBBBBiiiittttmmmmaaaapppp::::::::QQQQBBBBiiiittttmmmmaaaapppp (((())))
  76.       Constructs a null bitmap.
  77.  
  78.       See also: QPixmap::isNull().
  79.  
  80.      QQQQBBBBiiiittttmmmmaaaapppp::::::::QQQQBBBBiiiittttmmmmaaaapppp ((((    ccccoooonnnnsssstttt QQQQSSSSiiiizzzzeeee &&&& ssssiiiizzzzeeee,,,, bbbboooooooollll cccclllleeeeaaaarrrr ==== FFFFAAAALLLLSSSSEEEE ))))
  81.       Overloaded constructor; takes    a QSize    parameter instead of
  82.       (_w,_h).
  83.  
  84.      QQQQBBBBiiiittttmmmmaaaapppp::::::::QQQQBBBBiiiittttmmmmaaaapppp ((((    ccccoooonnnnsssstttt QQQQSSSSiiiizzzzeeee &&&& ssssiiiizzzzeeee,,,, ccccoooonnnnsssstttt uuuucccchhhhaaaarrrr    **** bbbbiiiittttssss,,,,    bbbboooooooollll
  85.       iiiissssXXXXbbbbiiiittttmmmmaaaapppp====FFFFAAAALLLLSSSSEEEE ))))
  86.       Overloaded constructor; takes    a QSize    parameter instead of
  87.       (_w,_h).
  88.  
  89.      QQQQBBBBiiiittttmmmmaaaapppp::::::::QQQQBBBBiiiittttmmmmaaaapppp ((((    ccccoooonnnnsssstttt QQQQBBBBiiiittttmmmmaaaapppp &&&&    bbbbiiiittttmmmmaaaapppp ))))
  90.       Constructs a bitmap which is a copy of _b_i_t_m_a_p.
  91.  
  92.      QQQQBBBBiiiittttmmmmaaaapppp::::::::QQQQBBBBiiiittttmmmmaaaapppp ((((    ccccoooonnnnsssstttt cccchhhhaaaarrrr **** ffffiiiilllleeeeNNNNaaaammmmeeee,,,, ccccoooonnnnsssstttt cccchhhhaaaarrrr **** ffffoooorrrrmmmmaaaatttt====0000 ))))
  93.       Constructs a pixmap from the file _f_i_l_e_N_a_m_e. If the file does
  94.       not exist, or    is of an unknown format, the pixmap becomes a
  95.       null pixmap.
  96.  
  97.       The parameters are passed on to QPixmap::load().
  98.  
  99.       See also: QPixmap::isNull(), QPixmap::load(),
  100.       QPixmap::loadFromData(), QPixmap::save() and
  101.       QPixmap::imageFormat().
  102.  
  103.      QQQQBBBBiiiittttmmmmaaaapppp::::::::QQQQBBBBiiiittttmmmmaaaapppp ((((    iiiinnnntttt wwww,,,, iiiinnnntttt hhhh,,,, bbbboooooooollll cccclllleeeeaaaarrrr ==== FFFFAAAALLLLSSSSEEEE ))))
  104.       Constructs a bitmap with _w width and _h height.
  105.  
  106.       The contents of the bitmap is    uninitialized if _c_l_e_a_r is
  107.       FALSE, otherwise it is filled    with pixel value 0 (the    QColor
  108.       color0).
  109.  
  110.      QQQQBBBBiiiittttmmmmaaaapppp::::::::QQQQBBBBiiiittttmmmmaaaapppp ((((    iiiinnnntttt wwww,,,, iiiinnnntttt hhhh,,,, ccccoooonnnnsssstttt uuuucccchhhhaaaarrrr **** bbbbiiiittttssss,,,, bbbboooooooollll
  111.       iiiissssXXXXbbbbiiiittttmmmmaaaapppp====FFFFAAAALLLLSSSSEEEE ))))
  112.       Constructs a bitmap with _w width and _h height    and sets the
  113.       contents to _b_i_t_s.
  114.  
  115.       The _i_s_X_b_i_t_m_a_p    should be TRUE if _b_i_t_s was generated by    the
  116.       X11 bitmap program. The X bitmap bit order is    little endian.
  117.       The QImage documentation discusses bit order of monochrome
  118.       images.
  119.  
  120.       Example (creates an arrow bitmap):
  121.  
  122.           uchar arrow_bits[] = { 0x3f, 0x1f, 0x0f, 0x1f, 0x3b, 0x71, 0xe0, 0xc0 };
  123.           QBitmap bm( 8, 8,    arrow_bits, TRUE );
  124.  
  125.      QQQQBBBBiiiittttmmmmaaaapppp &&&& QQQQBBBBiiiittttmmmmaaaapppp::::::::ooooppppeeeerrrraaaattttoooorrrr==== (((( ccccoooonnnnsssstttt QQQQIIIImmmmaaaaggggeeee &&&& iiiimmmmaaaaggggeeee ))))
  126.  
  127.  
  128.  
  129.      PPPPaaaaggggeeee 2222                         ((((pppprrrriiiinnnntttteeeedddd 9999////22222222////99998888))))
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      QQQQBBBBiiiittttmmmmaaaapppp((((3333qqqqtttt))))    TTTTrrrroooollllllll TTTTeeeecccchhhh AAAASSSS ((((9999 JJJJuuuullllyyyy 1111999999998888))))      QQQQBBBBiiiittttmmmmaaaapppp((((3333qqqqtttt))))
  137.  
  138.  
  139.  
  140.       Converts the image _i_m_a_g_e to a    bitmap that is assigned    to
  141.       this bitmap. Returns a reference to the bitmap.
  142.  
  143.       Dithering will be performed if the image has a depth greater
  144.       than 1.
  145.  
  146.      QQQQBBBBiiiittttmmmmaaaapppp &&&& QQQQBBBBiiiittttmmmmaaaapppp::::::::ooooppppeeeerrrraaaattttoooorrrr==== (((( ccccoooonnnnsssstttt QQQQPPPPiiiixxxxmmmmaaaapppp &&&& ppppiiiixxxxmmmmaaaapppp ))))
  147.       Assigns the pixmap _p_i_x_m_a_p to this bitmap and returns a
  148.       reference to this bitmap.
  149.  
  150.       Dithering will be performed if the pixmap has    a depth
  151.       greater than 1.
  152.  
  153.      QQQQBBBBiiiittttmmmmaaaapppp &&&& QQQQBBBBiiiittttmmmmaaaapppp::::::::ooooppppeeeerrrraaaattttoooorrrr==== (((( ccccoooonnnnsssstttt QQQQBBBBiiiittttmmmmaaaapppp &&&& bbbbiiiittttmmmmaaaapppp ))))
  154.       Assigns the bitmap _b_i_t_m_a_p to this bitmap and returns a
  155.       reference to this bitmap.
  156.  
  157.      QQQQBBBBiiiittttmmmmaaaapppp QQQQBBBBiiiittttmmmmaaaapppp::::::::xxxxFFFFoooorrrrmmmm (((( ccccoooonnnnsssstttt QQQQWWWWMMMMaaaattttrrrriiiixxxx &&&& mmmmaaaattttrrrriiiixxxx ))))    ccccoooonnnnsssstttt
  158.       Transforms the bitmap    using _m_a_t_r_i_x, and returns the
  159.       transformed bitmap.
  160.  
  161.       This function    does exactly the same as QPixmap::xForm(),
  162.       except that it returns a QBitmap instead of a    QPixmap.
  163.  
  164.       See also:  QPixmap::xForm().
  165.  
  166.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  167.       hhhhttttttttpppp::::////////wwwwwwwwwwww....ttttrrrroooollllllll....nnnnoooo////qqqqtttt////qqqqbbbbiiiittttmmmmaaaapppp....hhhhttttmmmmllll
  168.  
  169.      CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT
  170.       Copyright 1992-1997 Troll Tech AS.  See the LICENSE file
  171.       included in the distribution for a complete license
  172.       statement.
  173.  
  174.      AAAAUUUUTTTTHHHHOOOORRRR
  175.       Generated automatically from the source code.
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                         (printed 9/22/98)
  196.  
  197.  
  198.  
  199.